Resource URL: /platform/<<version=3>>/event/eventgroup-occurrences/<ID>

    Overview: This resource applies the standard collection pattern to
              individual eventgroup occurrences.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve individual eventgroup occurrence.

       URL: GET /platform/<<version=3>>/event/eventgroup-occurrences/<ID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "eventgroups": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Record of a eventgroup occurrence.", 
            "properties": {
              "resolved": {
                "type": "boolean", 
                "description": "True if eventgroup is resolved."
              }, 
              "ignore": {
                "type": "boolean", 
                "description": "True if eventgroup is marked as 'ignore'."
              }, 
              "severity": {
                "type": "string", 
                "description": "Event Group severity."
              }, 
              "event_count": {
                "type": "integer", 
                "description": "Number of events linked to this eventgroup."
              }, 
              "ignore_time": {
                "type": "integer", 
                "description": "Time eventgroup was marked as 'ignore'."
              }, 
              "time_noticed": {
                "type": "integer", 
                "description": "Time of first event linked to this eventgroup."
              }, 
              "last_event": {
                "type": "integer", 
                "description": "Time the most recent event was added to this eventgroup."
              }, 
              "sequence": {
                "type": "integer", 
                "description": "Unique sequence number assigned to the eventgroup, by order of creation."
              }, 
              "eventgroup_instance": {
                "type": "string", 
                "description": "Unique identifier of eventgroup instance."
              }, 
              "channels": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "List of channels to which alerts are configured for this eventgroup."
              }, 
              "resolver": {
                "type": "string", 
                "description": "'USER' if the eventgroup was marked resolved via PAPI <event_instance> if eventgroup was marked resolved as a result of an event."
              }, 
              "specifier": {
                "type": "object", 
                "description": "A collection of parameters defined per eventgroup_id."
              }, 
              "resolve_time": {
                "type": "integer", 
                "description": "When the eventgroup became resolved."
              }, 
              "id": {
                "type": "string", 
                "description": "Same as eventgroup_instance."
              }, 
              "causes": {
                "items": {
                  "items": {
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Event Group cause as name and description"
                }, 
                "type": "array", 
                "description": "List of eventgroup IDs that may be causes of this occurrence."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: modify eventgroup occurrence.

       URL: PUT /platform/<<version=3>>/event/eventgroup-occurrences/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Ignore flag for eventgroup.", 
  "properties": {
    "ignore": {
      "type": "boolean", 
      "description": "True if eventgroup is to be ignored"
    }, 
    "resolved": {
      "type": "boolean", 
      "description": "True if eventgroup is to be resolved"
    }
  }
}

There is no JSON response body for this method.
